Cómo nombrar variables: La guía completa para un código más legible
¿Alguna vez te has quedado sin saber cómo llamar a una variable en tu código? Si tú eres desarrollador o estás aprendiendo a programar, seguramente te habrás enfrentado a este reto más de una vez, debido a que Una de las tareas más desafiante a la que los desarrolladores se enfrentan a diario es encontrar los nombre adecuados para sus variables.
Darle los nombres a las variables puede ser una tarea complicada, ya que parece que nos quedamos sin ideas y acabamos eligiendo nombres poco descriptivos o incluso confusos. Afortunadamente, existen un conjunto de reglas y mejores prácticas que pueden ayudarnos a nombrar adecuadamente a nuestras variables y hacer que nuestro código sea más fácil de leer y entender.
En este blog te hablaré sobre las reglas para la nomenclatura y como nombrar variables según el tipo de dato. Así podrás escribir código más limpio, fácil de mantener y profesional usando nombres de variables apropiados.
Reglas fundamentales de nomenclatura para elegir los nombres de las variables
A la hora de darle nombre a las variables, es indispensable guiarnos por un conjunto de reglas y buenas prácticas que nos ayudaran a mantener el código limpio y fácil de leer. Por eso, vamos a ver tres reglas básicas que debes seguir para elegir los nombres de las variables de forma adecuada. Estas reglas son.
- Nombres pronunciables y expresivos
- Nombres sin información técnica
- Usar lenguaje ubicuo
Nombres pronunciables y expresivos
Cuando estamos hablando de nombres pronunciables y expresivos nos estamos refiriendo a que los nombres de las variables deben ser fácil de pronunciar y entender para cualquier persona que lea el código. Por otro lado, el nombre debe ser descriptivo para que indique el propósito de la variable.
Además, es recomendado que los nombres estén en inglés, usando camelCase y evitando guiones - _ y abreviaturas.
Nombres sin información técnica
Otra regla importante para nombrar las variables es evitar nombres que contengan información técnica. Es decir, el nombre de la variable no debe revelar el tipo de datos que contiene o como es su implementación técnicamente. Por el contrario, el nombre debe hablar sobre su funcionalidad y su propósito en el contexto del programa.
Ejemplos de nombres con información técnica:
Ejemplos de nombres sin información técnica
Usar lenguaje ubicuo
la tercera regla es usar lenguaje ubicuo. Esto significa que los nombres de las variables deben coincidir con el lenguaje usado en el tratamiento del problema en el que se está trabajando. Por ejemplo, si estamos trabajando en un programa de gestión de ventas, el nombre de las variables debe reflejar el vocabulario específico utilizado en ese campo, como "precio", "cantidad", "cliente", etc.
Ejemplos de lenguaje ubicuo
Cómo nombrar variables según su tipo de datos: Mejores prácticas
Nombrar las variables según su tipo de datos puede mejorar enormemente la legibilidad y comprensión del código. Pero esto no quiere decir que tenemos que poner el tipo de dato en el nombre de la variable, debido a que si hacemos eso, estaríamos dejando información técnica en la variable. En su lugar, debemos usar nombres que coincidan con el tipo de dato y que indiquen su función y propósito.
Por ejemplo, para una variable que guarda un número entero, podemos usar palabras como "max", "min" o "total" antes del nombre de la variable. Para una variable que guarda un valor booleano, podemos usar esValido, tieneDescuento o estaActivo. Para una variable que guarda una cadena de texto, podemos usar nombre, apellido o direccion. Así podemos nombrar las variables según su tipo de dato sin decirlo explícitamente en el nombre.
Números enteros: Mejores prácticas para nombrar variables que almacenan enteros
Una buena práctica para nombrar variables de valor numérico es usar prefijos que indiquen el valor o la función de la variable, como "max", "min" o "total" antes del nombre de la variable, para que sea más comprensible su función en el programa. Por ejemplo, si tenemos una variable que tiene como objetivo guardar el número de usuarios en un programa, podemos nombrar la variable "totalUsers".
Valores booleanos: Cómo nombrar variables que almacenan valores verdadero/falso
Una buena práctica para nombrar variables que almacenan valores booleanos es la de usar prefijos que indiquen una condición o una capacidad de la variable, como "is", "can" o "has" . Por ejemplo, si tenemos una variable que almacena si un usuario está activo o no, podríamos nombrarla como "isActive".
Arreglos: Mejores prácticas para nombrar variables que almacenan arrays
Al nombrar variables que almacenan arrays es una buena práctica usar el nombre de la variable en plural. Esto indica que la variable contiene más de un elemento y que se puede acceder a ellos mediante un índice o una clave. Por ejemplo, si tenemos una variable que guarda una lista de nombres, podemos usar nombres como nombre de la variable. Si tenemos una variable que guarda un conjunto de números, podemos usar numeros como nombre.
Si estás interesado en aprender más acerca de clean code y buenas prácticas, te invito a tomar el Curso de Clean Code y Buenas Prácticas con JavaScript, en Platzi. Este tutorial está 100% inspirado y basado en este curso.
Por último, quiero darle las gracias a la profesora Alex Camacho, quien es la persona que dista este curso. Y además, me gustaría destacar a Carina Payleman y Elcira Ibarra, que hicieron aportes muy destacados en la sesión de comentarios en la clase #5 y en la clase #6 respectivamente.